docs: Add details for gsk_renderer_new_for_surface
authorMatthias Clasen <mclasen@redhat.com>
Thu, 29 Oct 2020 18:58:12 +0000 (14:58 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Thu, 29 Oct 2020 22:21:44 +0000 (18:21 -0400)
Mention the GSK_RENDERER variable here.

gsk/gskrenderer.c

index 8ec0e0d36a62094e80de1f46171a027ae26f592f..dbbfd28f35b41f63ff1656850a1b52d3a6c6b2df 100644 (file)
@@ -606,7 +606,11 @@ static struct {
  *
  * Creates an appropriate #GskRenderer instance for the given @surface.
  *
- * The renderer will be realized when it is returned.
+ * If the `GSK_RENDERER` environment variable is set, GSK will
+ * try that renderer first, before trying the backend-specific
+ * default. The ultimate fallback is the cairo renderer.
+ *
+ * The renderer will be realized before it is returned.
  *
  * Returns: (transfer full) (nullable): a #GskRenderer
  */